feat:Update OpenAPI spec for consistent dataset listing across SDKs #134
Conversation
WalkthroughThe pull request modifies the OpenAPI specification for the Cohere API, focusing on dataset operations across multiple programming language SDKs. The primary change involves transitioning from retrieving a specific dataset by ID to listing all datasets consistently across Go, Python (sync and async), Java, TypeScript, and cURL implementations. This modification suggests a standardization of dataset retrieval methods across different SDK implementations. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/libs/Cohere/openapi.yaml(2 hunks)
🔇 Additional comments (1)
src/libs/Cohere/openapi.yaml (1)
9276-9288: LGTM! Consistent implementation across SDKs.The SDK implementations for Go, Python (sync/async), Java, and TypeScript are well-structured and consistent. They all:
- Use the standardized
.list()method- Follow language-specific best practices
- Demonstrate proper error handling (especially in Go)
- Use correct async/await patterns where applicable
| - sdk: curl | ||
| name: cURL | ||
| code: "curl --request GET \\\n --url https://api.cohere.com/v1/datasets \\\n --header 'accept: application/json' \\\n --header \"Authorization: bearer $CO_API_KEY\"" | ||
| code: "curl --request GET \\\n --url https://api.cohere.com/v1/datasets \\\n --header 'accept: application/json' \\\n --header \"Authorization: bearer $CO_API_KEY\"\n" |
There was a problem hiding this comment.
Fix inconsistent cURL endpoint for getting a specific dataset
The cURL endpoints appear inconsistent:
- List endpoint uses
/v1/datasets - Get endpoint uses
/v1/datasets/idwhereidseems to be a placeholder
For the get endpoint, replace the literal "id" with a placeholder consistent with other examples:
- --url https://api.cohere.com/v1/datasets/id \
+ --url https://api.cohere.com/v1/datasets/<<datasetId>> \Also applies to: 9443-9443
Summary by CodeRabbit